home *** CD-ROM | disk | FTP | other *** search
/ SGI Performance Co-Pilot 1.3 / SGI Performance Co-Pilot 1.3.iso / dist / dist6.4 / pcp.idb / usr / share / catman / u_man / cat3 / PMAPI / vkpcptimer.z / vkpcptimer
Text File  |  1997-04-03  |  7KB  |  199 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr((((3333xxxx))))                                                  VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkPCPtimer - timer interface for the the X main loop.
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkCallbackObject
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <PCP/VkPCPtimer.h>
  16.  
  17. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  18.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  19.            VkPCPtimer();
  20.            virtual ~VkPCPtimer();
  21.  
  22.  
  23.    SSSSttttaaaarrrrttttiiiinnnngggg aaaannnndddd SSSSttttooooppppppppiiiinnnngggg
  24.           void start(int interval);
  25.           void stop(void);
  26.  
  27.  
  28. PPPPRRRROOOOTTTTEEEECCCCTTTTEEEEDDDD PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  29.    UUUUppppddddaaaatttteeeessss
  30.           virtual void tick(void);
  31.  
  32.  
  33. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  34.      VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr provides a simple interface to the Xt timeout mechanism, as
  35.      described in XXXXttttAAAAppppppppAAAAddddddddTTTTiiiimmmmeeeeOOOOuuuutttt(3x).  Applications create an instance of the
  36.      VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr class, register a callback function, and call the ssssttttaaaarrrrtttt(((())))
  37.      method.  The callback function will be called at the appropriate time
  38.      from the Xt main loop.  It is the responsibility of the application to
  39.      schedule the next timer.  This is usually done at the end of the callback
  40.      function itself.
  41.  
  42.  
  43.  
  44. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  45.    ttttiiiicccckkkk(((())))
  46.            virtual void tick(void);
  47.  
  48.  
  49.           This virtual function can be overridden by derived classes to allow
  50.           them to be notified when each timeout occurs.
  51.  
  52.    VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr(((())))
  53.            VkPCPtimer();
  54.  
  55.  
  56.           The constructor initializes a VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr object.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr((((3333xxxx))))                                                  VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr((((3333xxxx))))
  71.  
  72.  
  73.  
  74.    ~~~~VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr(((())))
  75.            virtual void ~VkPCPtimer(void);
  76.  
  77.  
  78.           Clean up all memory allocated by a VkPCPtimer object.  Any pending
  79.           timer is removed.
  80.  
  81.    ssssttttaaaarrrrtttt(((())))
  82.            void start(int interval)
  83.  
  84.  
  85.           Start the timer. This function must be called to start the timer.
  86.           The ttttiiiicccckkkk (((()))) method and all registered callbacks will be called after
  87.           _i_n_t_e_r_v_a_l milliseconds.  If the _i_n_t_e_r_v_a_l parameter is negative or
  88.           zero, the ccccaaaallllllllCCCCaaaallllllllbbbbaaaacccckkkkssss (((()))) inherited member function will be called
  89.           immediately and no timer will be scheduled.  The ssssttttaaaarrrrtttt (((()))) method
  90.           must be called again for the next timer.  If a periodic timer is
  91.           required, the ttttiiiicccckkkk() method or a registered callback can call the
  92.           ssssttttaaaarrrrtttt method again to reschedule the timer.  If a regular, real-time
  93.           synchronized timer is required, applications should measure the time
  94.           difference between successive timer callbacks, and adjust the
  95.           interval accordingly.
  96.  
  97.    ssssttttoooopppp(((())))
  98.            void stop(void);
  99.  
  100.  
  101.           Stop the timer, cancel and pending timer events.
  102.  
  103.    ssssttttaaaattttiiiicccc ccccoooonnnnsssstttt cccchhhhaaaarrrr ****ccccoooonnnnsssstttt ttttiiiimmmmeeeerrrrCCCCaaaallllllllbbbbaaaacccckkkk;;;;
  104.            static const char *const timerCallback;
  105.  
  106.  
  107.           This callback list allows other C++ classes derived from
  108.           VkCallbackObject to register member functions to be called at
  109.           periodic intervals.
  110.  
  111. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  112.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
  113.           callCallbacks(), addCallback(), removeCallback(),
  114.           removeAllCallbacks()
  115.  
  116.  
  117. CCCCLLLLAAAASSSSSSSSEEEESSSS UUUUSSSSEEEEDDDD BBBBYYYY TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  118.      VkPCParchiveTime, VkPCPliveTime
  119.  
  120. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  121.      VkPCParchiveTime, VkPCPliveTime
  122.      VkPeriodic, VkWindow, VkComponent, VkCallbackObject, VkMenu, VkMenuBar,
  123.      VkMenuItem
  124.      _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  125.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr((((3333xxxx))))                                                  VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr((((3333xxxx))))
  137.  
  138.  
  139.  
  140.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  141.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.